Azure Trusted Signing (preview:2023-06-15)

2025/09/05 • 4 new methods

CertificateProfileOperations_Sign (new)
Description :  Submit a sign operation under the created account and profile name provided.
Reference :  Link ¶

⚼ Request

POST:  /codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}:sign
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Azure Trusted Signing account name. ,
Required: True ,
}
string ,
certificateProfile:
{
Description: Azure Trusted Signing certificate profile name under an account. ,
Required: True ,
}
string ,
client-version:
{
Description: An optional client version. ,
Required: False ,
}
string ,
x-correlation-id:
{
Description: An identifier used to batch multiple requests. ,
Required: False ,
}
string ,
body:
{
Description: Body parameter. ,
Required: True ,
}
{
signatureAlgorithm:
{
Description: The supported signature algorithm identifiers. ,
Enum:
{
RS256: RSASSA-PKCS1-v1_5 using SHA-256 hash algorithm. ,
RS384: RSASSA-PKCS1-v1_5 using SHA-384 hash algorithm. ,
RS512: RSASSA-PKCS1-v1_5 using SHA-512 hash algorithm. ,
PS256: RSASSA-PSS using SHA-256 hash algorithm. ,
PS384: RSASSA-PSS using SHA-384 hash algorithm. ,
PS512: RSASSA-PSS using SHA-512 hash algorithm. ,
ES256: ECDSA using P-256 and SHA-256 hash algorithm. ,
ES384: ECDSA using P-384 and SHA-384 hash algorithm. ,
ES512: ECDSA using P-521 and SHA-512 hash algorithm. ,
ES256K: ECDSA using secp256k1 and SHA-256 hash algorithm. ,
}
,
Required: True ,
}
enum ,
digest:
{
Description: Content digest to sign. ,
Format: byte ,
Required: True ,
}
string ,
fileHashList:
{
Description: List of full file digital signatures. ,
Required: False ,
}
[
string ,
]
,
authenticodeHashList:
{
Description: List of authenticode digital signatures. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
signature:
{
Description: Digital signature of the requested content digest. ,
Format: byte ,
Required: False ,
}
string ,
signingCertificate:
{
Description: Signing certificate corresponding to the private key used to sign the requested digest. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CertificateProfileOperations_GetSigningStatus (new)
Description :  This status operation requires that a Sign request has been submitted and the operationId is known.
Reference :  Link ¶

⚼ Request

GET:  /codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Signing account name. ,
Required: True ,
}
string ,
certificateProfile:
{
Description: Signing Certificate profile name. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
signature:
{
Description: Digital signature of the requested content digest. ,
Format: byte ,
Required: False ,
}
string ,
signingCertificate:
{
Description: Signing certificate corresponding to the private key used to sign the requested digest. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CertificateProfileOperations_ListExtendedKeyUsages (new)
Description :  The list of extended key usages are used to determine the purpose of the certificate usage as part of the signing operation.
Reference :  Link ¶

⚼ Request

GET:  /codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/eku
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Azure Trusted Signing account name. ,
Required: True ,
}
string ,
certificateProfile:
{
Description: Azure Trusted Signing certificate profile name under an account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExtendedKeyUsage items on this page ,
Required: True ,
}
[
{
eku:
{
Description: An oid string that represents an eku. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CertificateProfileOperations_GetSignRootCertificate (new)
Description :  The root certificate is generated as part of the initial account creation and it is used to sign the bits for the profile provided.
Reference :  Link ¶

⚼ Request

GET:  /codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/rootcert
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountName:
{
Description: Signing account name. ,
Required: True ,
}
string ,
certificateProfile:
{
Description: Signing Certificate profile name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}